Skip to content

Correct README and user guide claims found in a doc sweep - #38

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/doc-accuracy-sweep-nov
Nov 5, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/doc-accuracy-sweep-nov

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

Stage A documentation accuracy sweep: every doc source of truth was checked against the source, plugin.yml, pom.xml, the workflows, the tests, and the v1.0.0 tag. Docs only; no code, manifest, or workflow is touched.

  • Supported versions: the README says every stable release is booted on each listed version, and both the README and user guide list 26.3 next to a "download the latest release" step. The only stable release, 1.0.0, predates 26.3 (git show v1.0.0:minecraft-versions.json lists 1.19.4, 1.21.11, 26.2; 26.3 arrived in Support Minecraft 26.3 #25, after the tag). Both docs now say so.
  • Hero image caption: it mentions "grey lines" between commands; docs/images/fly.png has none. The clause is removed.
  • Building: the README now states the build prerequisites. maven.compiler.release is rejected by JDK 8, which a reader of "compiled for Java 8" could reasonably try; the workflows use JDK 17.
  • Adding a version: "add it to the file" omitted the two prose lists that repeat it. The README now names them.

No tracking issue — gaps found during the sweep. All were doc fixes, so nothing was filed for code or manifest changes.

Skipped

Validation

  • mvn -B clean package was run on the branch; see the self-review comment for its output. The diff touches only Markdown.
  • The doc claims were checked against the commands quoted in the Summary and by viewing the image.
  • The JDK 8 statement was not run: only JDK 21 is available here. It rests on --release being a JDK 9+ javac option.
  • The DPC conventions pages could not be fetched in this sandbox, so README structure was not re-checked against them.

No on-server recipe applies, because no behavior changes.

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

The docs said every stable release is booted on each listed version,
but 26.3 joined the list after 1.0.0. Also drop the hero image
caption's grey lines, which the image does not have, and state the JDK
a build needs and everywhere a new supported version must be listed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric for head 8f858e9, performed inline in the dispatching session. This is a self-review, not an independent one: requesting Copilot failed with Could not resolve user with login 'copilot'.

External anchors:

  • mvn -B clean package: Tests run: 7, Failures: 0, Errors: 0, Skipped: 0, BUILD SUCCESS.
  • gh pr checks 38: build pass 20s. The Build workflow compiles, tests, and runs the Bukkit API check, so this check carries real signal; the skill's "checkout-only" description of it is out of date (flycommand-dev-loop#8). It cannot speak to Markdown accuracy, however.

Rubric:

  • Scope: PASS. git diff --name-only origin/main...HEAD lists only CHANGELOG.md, README.md, USER_GUIDE.md.
  • Validation-new: PASS. Each claim was checked against a named source: git show v1.0.0:minecraft-versions.json printed ["1.19.4", "1.21.11", "26.2"]; docs/images/fly.png was viewed and shows no grey lines; pom.xml:17 sets maven.compiler.release to 8; all three workflows set java-version: '17'.
  • Validation-fix: not applicable. No code or manifest defect is fixed.
  • Validation of the JDK 8 sentence: UNVERIFIED by execution. Only JDK 21 is available here; the sentence rests on --release being a JDK 9+ javac option.
  • Sibling structure and renames: PASS. No new file; no heading renamed, so the USER_GUIDE.md#installation anchor resolves to the existing ## Installation.
  • Docs: PASS. All sources of truth were swept; grep confirms FlyCommand.fly in plugin.yml, USER_GUIDE.md, COMMANDS.md, CONFIG.md.
  • Issue resolution: FLAGGED. No issue is closed and CONTRIBUTING.md asks for an issue reference. The PR body records "No tracking issue", which the loop allows for gaps found during a sweep.
  • Manifest, command, and main-class agreement: PASS. Main.java:29 checks FlyCommand.fly, declared at plugin.yml:12; Main.java:22 compares fly, declared as Fly at plugin.yml:7. Neither file is changed.
  • No stack change: PASS. No build file or dependency is touched.
  • Changelog: PASS, with one nit. CHANGELOG.md:16-18 — the JDK prerequisite is arguably an addition rather than a fix, but it shares a bullet under ### Fixed; left as is, since it is a doc correction in the same sweep.
  • Harness leakage: PASS. No .claude/ path in the diff.

Follow-up on the same text: README.md:12 and USER_GUIDE.md:13 carry a 26.3 sentence that goes stale at the next stable release. This is noted on #36.

Do-not-auto-merge paths: none match. The largest single-file deletion is under 50 lines.

This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 0aab49b into main Nov 5, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the feature/doc-accuracy-sweep-nov branch November 5, 2026 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant